/*
 * Copyright (c) 2025 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License"),
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @addtogroup TeeTrusted
 * @{
 *
 * @brief TEE（Trusted Excution Environment）可信执行环境API。
 *
 * 提供安全能力API，例如可信存储、加解密及可信时间等，用于可信应用程序开发。
 *
 * @since 20
 */

/**
 * @file tee_core_api.h
 *
 * @brief 提供用于管理可信应用（TA）会话的API。
 *
 * @library NA
 * @kit TEEKit
 * @include <TEEKit/tee_core_api.h>
 * @syscap SystemCapability.Tee.TeeClient
 * @since 20
 */

#ifndef __TEE_CORE_API_H
#define __TEE_CORE_API_H

#include "tee_defines.h"

#ifdef __cplusplus
extern "C" {
#endif

#ifndef _TEE_TA_SESSION_HANDLE
/**
 * @brief 定义TA会话的句柄。
 *
 * @since 20
 */
#define _TEE_TA_SESSION_HANDLE

/**
 * @brief 定义TA会话句柄类型。
 *
 * @since 20
 */
typedef uint32_t TEE_TASessionHandle;
#endif

/**
 * @brief 在TA实例中触发panic。
 *
 * @param panicCode 指定由TA定义的panic代码。
 *
 * @since 20
 */
void TEE_Panic(TEE_Result panicCode);

/**
 * @brief 打开与TA的新会话。
 *
 * @param destination 指向TEE_UUID结构体的指针，其中包含目标TA的通用唯一标识符 (UUID)。
 * @param cancellationRequestTimeout 指定超时时间（以毫秒为单位），或特殊值表示无超时。
 * @param paramTypes 指定在操作中传递的所有参数的类型。
 * @param params 指向操作中传递的参数。
 * @param session 指向用于接收客户端会话句柄的变量的指针。
 * @param returnOrigin 指向保存返回来源的变量的指针。
 *
 * @return TEE_SUCCESS：会话已成功打开。\n
 *         TEE_ERROR_ITEM_NOT_FOUND：在可信执行环境 (TEE)中未找到TA。\n
 *         TEE_ERROR_ACCESS_DENIED：对TA的访问请求被拒绝。
 * @since 20
 */
TEE_Result TEE_OpenTASession(const TEE_UUID *destination, uint32_t cancellationRequestTimeout, uint32_t paramTypes,
                             TEE_Param params[TEE_PARAMS_NUM], TEE_TASessionHandle *session, uint32_t *returnOrigin);

/**
 * @brief 关闭客户端会话。
 *
 * @param session 指定要关闭的会话句柄。
 *
 * @since 20
 */
void TEE_CloseTASession(TEE_TASessionHandle session);

/**
 * @brief 在此客户端TA实例与目标TA实例之间打开的会话中调用命令。
 *
 * @param session 指定已打开的会话句柄。
 * @param cancellationRequestTimeout 指定超时时间（以毫秒为单位），或特殊值表示无超时。
 * @param commandID 指定要调用的命令的标识符。
 * @param paramTypes 指定在操作中传递的所有参数的类型。
 * @param params 指向操作中传递的参数。
 * @param returnOrigin 指向保存返回来源的变量的指针。
 *
 * @return TEE_SUCCESS：操作成功。\n
 *         TEE_ERROR_ACCESS_DENIED：命令调用失败。
 * @since 20
 */
TEE_Result TEE_InvokeTACommand(TEE_TASessionHandle session, uint32_t cancellationRequestTimeout, uint32_t commandID,
                               uint32_t paramTypes, TEE_Param params[TEE_PARAMS_NUM], uint32_t *returnOrigin);

#ifdef __cplusplus
}
#endif

#endif
/** @} */